home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
maximus
/
scp_v110.zip
/
SC.DOC
< prev
next >
Wrap
Text File
|
1993-03-08
|
44KB
|
1,138 lines
DOX sixxac/CHAT v1.10
████████████ ████ ███ ███ ███ ███ █████████ ████████
███ ████ ███ ███ ██ ███ ██
████████████ ████ █████████ █████████ ██ ███ ██
▄▄▄▄▄ ▄▄▄▄ ▄▄▄ ▄▄▄ ▄▄ ▄▄▄ ▄▄
████████████ ████ ███ ███ ███ ███ ██ ███ ████████
Christian Zangl FidoNode 2:31/21.0
sysop of sixxac's hideout bbs phone # +43-4242-57884
────────────────────────────────────────────────────────────────────
sixxac/CHAT LEGAL STUFF
────────────────────────────────────────────────────────────────────
sixxac/CHAT is SHAREWARE - it is provided as is, with no warranty
of any kind, either expressed or implied. sixxac/CHAT is not even
guaranteed to occupy disk space ;). You are free to copy and
distribute the sixxac/CHAT archive freely, provided no changes or
additions are made to the package (except that you may use you
favorite package format).
Christian Zangl (me, the author) shall in no event be held liable
to you or anyone else for any damages of any kind, incidental or
consequential, arising from the use or inability to use this
program.
Maximus-CBCS is a Trademark and Copyright by Scott J. Dudley.
──────────────────────────────────────────────────────────────────────
sixxac/CHAT REGISTRATION
You have to register sixxac/CHAT within a month or stop using it!
With the registration of sixxac/CHAT you'll get a REGISTER KEY to
enable TTY chat mode, full alias and macro functions (in the
unregistered version they are turned off after 15 minutes) and
you support me to make future versions.
The registration fee has to be paid in Austrian Schillings (ATS)!
Its price is 200.-- ATS (about 19.-- US$).
Please print and fill in the registration form, or if it is
possible, fill in your data with an editor and then print it out.
The registration form is in the file "REGISTER.DOC" that came with
this package.
Send the registration form to
Christian Zangl FidoNet 2:31/21.0
Franz-Krainer-Str. 42 BBS Phone +43-4242-57884
9500 Villach
Austria, Europe
You may also send the registration form by electronic mail to my BBS,
but if you do this via FidoNet please CRASH the mail to me - just for
security reasons.
There are many ways to send me the money, but don't forget that *you*
have to pay the *transfer fee*!
Here are some:
o send me a cheque that is drawn on the Austrian bank
"Bank fuer Kaernten und Steiermark"
o use an international postal money order (ask your local
postoffice for more information about that)
o send me a normal cheque
o put the money into an envelope and mail it to me
────────────────────────────────────────────────────────────────────
sixxac/CHAT MAIN FEATURES
────────────────────────────────────────────────────────────────────
o Chat windows with everythig that is standard (including word
wrap, cursor keys, ...)
o Window size and positions are changeable using the config file
or even _while_ chatting (with the mouse).
o Fully configurable with more than 60 different configuration
keywords (colors, borders, ...).
o Scrolling or overwriting mode for chat window (with autodetect
depending on callers baud rate) and autodetect for the number
of lines to scroll (but also changeable while chatting).
o ANSI to TTY adapter. This enables you to chat (in a
split screen) to a user that uses only a TTY terminal!
o Capture chat to Maximus compatible ASCII logfile (in " FL> text"
style like a fido message) and/or to an ANSI logfile.
o Support for _unlimited_ aliases and key macros (including a
startup macro)! They can be activated for the user, sysop or
both. Also several translation characters (user name, time,
quotes, remaining time, ...) are available.
o Yell MODE includes events for paging times, length of yelling,
what tune to play or if the user may select the tune (from the
Maximus tunes.bbs file) and converts the tune on the fly to
ANSI MUSIC to play it to the user (same tunes can be played
while chatting!). It's also possible to display your ansi yelling
file simultaneously to the yell-countdown.
o User settings (for as many users as you wish) and a global setting
for all other users to specify the level, number of tunes per
day/event, tune and length of yell.
o FAST Scroll back - only for the sysop to look what he or the user
said an hour ago (the user won't notice anything)
o Support for LASTUSER.BBS to stop the users time, toggle the nerd
flag or exit automaticaly if the users time is up. You can also
specify what key to set if you did not answer the yell and use
MECCA to ask him to leave a comment.
o Include other config files depending on the system time. So you
can use differend colors, window styles, ansi yell files,
tune files, quotes, ... at different days or times.
────────────────────────────────────────────────────────────────────
sixxac/CHAT versions and operating systems
────────────────────────────────────────────────────────────────────
Currently there are three different versions of sixxac/CHAT
available:
o OS/2 version v 1.10.OS2.xx
This is the most powerfull version yet!
o OS/2 Multiline version v 1.03.ML2b.xx (beta)
The beta version was discontinued temporarily.
o DOS version v 0.04.DOSb.xx (beta)
This is a quick port of the 1.04.OS2 version to
DOS. It has not the power nor the speed but works
quite well. NOTE: read "READ_DOS.DOC" for more
information!
────────────────────────────────────────────────────────────────────
sixxac/CHAT SYSTEM REQUIREMENTS
────────────────────────────────────────────────────────────────────
o an IBM (or compatible) personal computer running OS/2
with some free (virtual) memory
o IBM-OS/2 version 2.0 or greater
o some space on your harddisk (about 300kb)
o a BBS software capable passing the FILE HANDLE of the
COMM port to sixxac/CHAT (like Maximus)
────────────────────────────────────────────────────────────────────
Quick installation
────────────────────────────────────────────────────────────────────
Edit sc.cfg to fit your needs (don't forget to set the
correct sysop name).
Then make a directory "sc" in your maximus directory. (If your
maximus directory is called "d:\max" make "d:\max\sc") and move
all files from this package to this directory.
──────────────────────────────────────────────────────────────────────
MAXIMUS MECCA configuration:
Put this lines into max\MISC\F1.MEC (or any other Fx.MEC you
wish to use).
For single line systems (use the sample file F1.MEC in the
maxconf.zip archive):
[white]loading sixxac/CHAT
[Xtern_run]@sc\scp.exe -p%P -csc\sc.cfg -mlastuser.bbs
For multiline systems (use the sample file F2.MEC in the
maxconf.zip archive):
[white]loading sixxac/CHAT
[Xtern_run]@sc\scp.exe -p%P -csc\sc.cfg -x%k -mlastus%K.bbs
then run meccap.exe (that came with Maximus) on this file or just
use the Fx.BBS file from the maxconf.zip archive. After this you
can use the <F1> or <F2> key in Maximus to start a chat with the
user (and without entering the yell mode).
──────────────────────────────────────────────────────────────────────
MAXIMUS Menu configuration:
Add this line to you menus.ctl file (it is located in your
Maximus directory):
Display_File misc\yellsc Disgrace "Yell for SYSOP"
and and *remove* the old "yell for sysop" Line that may look
like this:
Yell Disgrace "Yell for SysOp"
If you forget to remove it the user will yell once with sixxac/CHAT
and once with Maximus-yell!
Then make a file call yellsc.mec (use "yellsc.mec" from the
samples.zip archive) in the max\misc directory that has the following
text in it:
[white on black]
[white]loading sixxac/CHAT
[Xtern_run]@sc\scp.exe -p%P -csc\sc.cfg -mlastuser.bbs -y
[cyan on black][ne /Q][quit]
Sorry, the sysop is not available yet!
Do you wish to leave him a private message? [[y,N] [ansreq menu]yn|
[choice]Y[leave_comment]
If you are multiline just use the file "yellscm.mec" that came in the
samples.zip archive!
Now don't forget to make a "siltp max" and run a "meccap misc\yellsc"
(also included with Maximus)!
──────────────────────────────────────────────────────────────────────
MAXIMUS CHAT KEY (ALT-C) configuration:
Edit you max.ctl file and change the "Chat External", if you
have a single line system to:
Chat External sc\scp.exe -p%P -mlastuser.bbs -csc\sc.cfg
For multiline systems use:
Chat External sc\scp.exe -p%P -x%k -mlastus%K.bbs -csc\sc.cfg
and run siltp max!
────────────────────────────────────────────────────────────────────
KEY assingments
────────────────────────────────────────────────────────────────────
──────────────────────────────────────────────────────────────────────
SYSOP KEYS while in MultiLine Server mode:
<SPACE> LOGON - opens a chat window for the sysop
<ESC> LOGOFF all users and exit sixxac/CHAT
──────────────────────────────────────────────────────────────────────
SYSOP KEYS while chatting:
<F1> toggle the scrolling in the chat window
to overwrite mode
<F2> turn ascii logfile on/off
<F3> redraw screen. usefull for noisy
telephone lines.
<F4> toggle user level. this effects only the
users possibility to play ansi music and
if you can hear the music.
<F5> toggle window positions
<F6> clear all chat windows
<Page Up> if you are not already in scrollback mode
you would enter it and and scroll up
one page
<Page Down> as <Page Up> but scroll down one page
<Cursor Up> as <Page Up> but scroll up one line
<Cursor Down> as <Page Up> but scroll up one page
<Pos1> when not in scrollback mode, go to the
beginning of the line, when in scrollback
mode go to the begining of the chat.
<End> end scrollback mode or if not in scrollback mode
go to the end of the line.
──────────────────────────────────────────────────────────────────────
USER & SYSOP KEYS while chatting:
<CTRL>+<k> same as <F1>
<CTRL>+<l> same as <F3>
<CTRL>+<d> clear your own window
──────────────────────────────────────────────────────────────────────
SYSOP KEYS while user is yelling or selecting tunes:
<ESC> abort YELL and drop the user back to where he
came from (bbs).
<TAB> abort YELL and display the YELL_NO ansi file
defined in the config.
<SPACE> turn the sound off. Yelling will continue, but
you won't hear anything.
any other key (no not the reset key ;) to begin chatting.
────────────────────────────────────────────────────────────────────
Mouse support
────────────────────────────────────────────────────────────────────
Klick on the first row of the window to move it.
>> ╒════════[ Christian Zangl ]════════╕ <<
│ │
│ │
│ │
│ │
│ │
└───────────────────────────────────┘ <
To resize the window click on the lower right edge.
Click into the window to exchange it with another
(like drag&drop).
────────────────────────────────────────────────────────────────────
DEFAULT ALIASES
────────────────────────────────────────────────────────────────────
They are activated when typed in a chat window - just like
normal aliases.
──────────────────────────────────────────────────────────────────────
SCROLL LINES "/s"
Syntax: /s[line#]
See the config keyword "SCROLL_LINES" for more information.
──────────────────────────────────────────────────────────────────────
TUNES & ANSI MUSIC "/t"
sixxac/CHAT is able to convert many tunes to ansi music and
play them to the user if his terminal software supports ansi
music!
At this time I only know that Telemate 3.10 is able to do
play music, but the user will automaticaly be showed if he has
this support.
Within sixxac/CHAT you've a special feature to play tunes and/or
music _while_ chatting! It's used like an alias and has the
following syntax:
/t[s|b|u|x][<tune#>]
s: play tune to sysop
b: play tune to sysop and music to user
u: play music to user
x: use last settings
no option: turn music off
Type these examples while chatting with the user:
/ts36 play tune number 36 to the sysop
/tb play last tune/music to both user and sysop
/tu1 play tune number 1 to the uesr
/t turn tune/music off
/t2 play tune number 2 to user/sysop as specified
in the last tune
Note: the user has to use a terminal program that supports
ansi music!
──────────────────────────────────────────────────────────────────────
WINDOW STYLES "/w"
This allows you to alter your window positions and window sizes.
It's used like an alias and has the following syntax:
/w{<shift>|#<style><shift>}
<style> may be a number from 0 to 3 with the following meaning:
0: sysop bottom, user top
1: sysop left, user right
2: sysop top, user bottom
3: sysop right, user left
<shift> is the number of lines/chars to make the sysop chat window
bigger than normal. If you use a number smaller than zero the users
window will get bigger.
Examples:
If you want a big window and the user needs only a few lines
then type: /w8
To get your window on to right (the users to the left) and
give him more space to write use: /w#3-10
(If you need more space use /w#310)
────────────────────────────────────────────────────────────────────
sixxac/CHAT COMMANDLINE USAGE
────────────────────────────────────────────────────────────────────
scp [-pFH] [-bBAUD] [-nUNAME] [-cCNF] [-xNode] [-y] [-gGM]
[-z] [-sCC] [-mLU]
-p Filehandle: integer string containing the file handle of the
com port (default 0)
sixxac/CHAT must be passed the FILE HANDLE of the opened com
port from the BBS software (Maximus). Using the sample
mecca file (F6.MEC) or the sample menus.ctl line supplied
with this document does this properly. DO NOT try to hard
code this value. Passing '1' for COM1: will NOT WORK!
All serial port options (bps, parity, handshaking) are
inherited from the BBS software (Maximus). sixxac/CHAT does
not open, close, or alter the comm parameters in any way
(so there is no support for XON/XOFF flow control)!
If FHANDLE is 0 sixxac/CHAT will use the keyboard instead
of the modem! This is useful for testing or (when a pipe
is used) a local chat over the network.
-b BAUD: integer string containing the connect speed
(default 9600)
This parameter is only used for automatic selection of
scrolling or overwriting!
-m LASTUSER: name and path to the lastuser.bbs file.
This file is created by Maximus and contains various
information about the user.
If you use this switch you should NOT specify the
-n, -g or -b parameters.
(if you encounter any problems with the baudrate you
may aditionally specify the -b parameter!)
-n Username: the users first and last name (default User)
Use the underscore '_' instead of a blank ' '!
-c CNF: path and name of the config file (default sc.cfg)
This is only needed if the config file is not named
sc.cfg or if it is not in the current directory.
-x Node: The current nodenumber in a multinode system
This enables the MULTINODE SUPPORT within sixxac/CHAT.
An extension of ".Lxx" (xx stands for the nodenumber)
will be added to all logfiles. If you don't have HPFS
then remove all logfilename extensions (including the
'.') from the config file!
-y Yelling mode (no default)
This activates check for the yell event and enables music
to get the sysop to the computer (check out the configuration
keywords Y_EVENT, TUNESFILE and YELL_...)
-g Grapicsmode (default ansi)
This switch selects weather to use ansi (GM=1) or tty (GM=0)
mode for the user. (you should let the bbs pass this
parameter (as the user selected it) to sixxac/CHAT - under
Maximus use -g %g)
To enable tty support you need a REGISTER KEY! Read the
registration section about how to get one.
TTY support will in no way alter your display (except for the
"TTY" on the status line), you are still using the split
screen!
The TTY user will have *no* split screen (that is not possible
in tty mode).
To avoid any "unreadable chats" the <pos1> <end> and cursor
keys are disabled. Also if you or the user type something
before the other one stops typing or did not press <enter>
after he finished - a new line is forced so that everything
is still readable for both of you.
If you select ansi everything is the same (really nice
colorfull split screen) on both sides.
-z CLIENTMODE (no default)
start sixxac/CHAT in CLIENT mode - check for a sixxac/CHAT
SERVER (if none is found it will start one) and connect to
the sixxac/CHAT server via pipe.
-s SERVERMODE and Chatchannel (no default)
start sixxac/CHAT in SERVER mode and wait for sixxac/CHAT
CLIENTS on chatline CC.
────────────────────────────────────────────────────────────────────
sixxac/CHAT configuration KEYWORDS
────────────────────────────────────────────────────────────────────
These are used in the sc.cfg config file. Don't use more than 1000
characters per line!
ALIAS <who> "<word>" "<words>" (no default)
──────────────────────────────────────────────────────────────────────
<who> activates the alias for B (both), U (the user) or S (for the
sysop).
An alias is used to change a word to a single word or a whole
sentence you've specified.
<word> has to be one single word (no blanks!)
<words> may contain anything you like, except the " character.
A special alias is named "startup" and will be executed at
startup. (has to be specified as the first alias!)
There are also some translation characters you may use.
charater(s) will be replaced by
%| carriage return.
%% % character
%f users firstname
%l users lastname
%t current time
%d todays date
%r remaining minutes in Maximus
(only with the -m switch!)
%c chattime
%q quote of the day
(you've to use the konfig keyword
QUOTEFILE to enable it)
%b users baudrate
%x In ML mode this will close the users window
and let him return to the bbs.
When standalone and REMOTE_EXIT is set to yes
this will end sixxac/CHAT.
You may define as many aliases as you wish, no limit!
some examples:
ALIAS S "startup" "Hi %f!%|"
ALIAS B "tschau" "ciao"
ALIAS S "cu" "well, i've to go,%|so ciao!"
ALIAS B "kb" "kilobyte"
ALIAS B "mb" "megabyte"
ALIAS U "shit" "<uff, smells bad in here...>"
ALIAS B "/first" "%f"
ALIAS B "/last" "%l"
ALIAS B "/time" "%t"
ALIAS B "/date" "%d"
ALIAS B "/chattime" "%c"
ALIAS B "/remain" "%r"
ALIAS B "/baud" "%b"
ALIAS B "/quit" "%x"
BORDER BOTTOM "<character>" (default "─")
BORDER BOTTOMLEFT "<character>" (default "└")
BORDER BOTTOMRIGHT "<character>" (default "┘")
BORDER LEFT "<character>" (default "│")
BORDER RIGHT "<character>" (default "│")
BORDER TOP "<character>" (default "═")
BORDER TOPLEFT "<character>" (default "╒")
BORDER TOPRIGHT "<character>" (default "╕")
──────────────────────────────────────────────────────────────────────
Here you may specify the characters used for the window border.
CLOCK <on/off> (default on)
──────────────────────────────────────────────────────────────────────
Display the time in the header line.
COLOR BG BORDER <bcolor> <bcolor> (default BLUE BLUE)
COLOR FONT BORDER <fcolor> <fcolor> (default WHITE WHITE)
──────────────────────────────────────────────────────────────────────
These set the border colors for the chat window.
FONT stands the color of the characters and BG is the background-
color.
The first color is used for your window, the second is used
for the users window.
<fcolor> may be BLACK, RED, GREEN, BROWN, BLUE, MAGENTA, CYAN
GRAY, DARK_GRAY, LIGHT_RED, LIGHT_GREEN, YELLOW, LIGHT_BLUE,
LIGHT_MAGENTA, LIGHT_CYAN or WHITE
<bcolor> may be BLACK, RED, GREEN, BROWN, BLUE, MAGENTA, CYAN
or GRAY
COLOR BG HEADER <bcolor> (default WHITE)
COLOR FONT HEADER <fcolor> (default BLACK)
──────────────────────────────────────────────────────────────────────
This color is used for the window header.
COLOR BG SCROLLBACK <bcolor> <bcolor> (default BLUE BLUE)
COLOR FONT SCROLLBACK <fcolor> <fcolor> (default YELLOW YELLOW)
──────────────────────────────────────────────────────────────────────
If you scrollback the chat it is displayed in this color.
COLOR BG STATUS <bcolor> (default BLACK)
COLOR FONT STATUS <fcolor> (default WHITE)
──────────────────────────────────────────────────────────────────────
Colors for the status line/screen (that displays if logfile,
scrolling is on/off).
COLOR BG WINDOW <bcolor> <bcolor> (default BLUE BLUE)
COLOR FONT WINDOW <fcolor> <fcolor> (default WHITE WHITE)
──────────────────────────────────────────────────────────────────────
Colors for the chat window.
COLOR BG YELL <bcolor> (default BLUE)
COLOR FONT YELL <fcolor> (default WHITE)
──────────────────────────────────────────────────────────────────────
Yelling colors (select tune and count down).
CONFIG <filename> <day> <start> <end> (no default)
──────────────────────────────────────────────────────────────────────
Include another config file.
<day> specifies on what day this config should be loaded, it may
be one of the following: all, mon, tue, wed, thu, fri, sat, sun
<start> at and after what time load the config (hh:mm)
<end> at and before what time load the config (hh:mm)
Example:
You want a different color for the chat windows between 23:00
and 8:00 to signal the caller that this is a "special" time to
chat with you.
Add this config keywords to sc.cfg:
CONFIG sc1.cfg all 23:00 24:00 ; you have to split it up if it
CONFIG sc1.cfg all 00:01 08:00 ; passes midnight!
And the sc1.cfg file has to contain something like
COLOR FONT WINDOW BLUE BLUE
COLOR BG WINDOW GRAY GRAY
COLOR FONT BORDER BLUE BLUE
COLOR BG BORDER GRAY GRAY
or any other special config you want.
DEFAULT_USER <name> (default Unknown User)
──────────────────────────────────────────────────────────────────────
The default user name. It will used if the -n parameter is
missing. As the sysops name, it is displayed on top of the users
chat window and the first letter of the firstname and the
lastname is used for the logfile.
REGISTER_KEY <string> (no default)
──────────────────────────────────────────────────────────────────────
Your register key. You'll get one if you register sixxac/CHAT!
This key enables TTY to SPLIT SCREEN chat!
LANGUAGE TTY_YELL <string> (no default)
──────────────────────────────────────────────────────────────────────
TTY message when yelling.
LANGUAGE TTY_NYET <string> (no default)
──────────────────────────────────────────────────────────────────────
TTY message when SYSOP is not available
LANGUAGE TTY_KEY <string> (no default)
──────────────────────────────────────────────────────────────────────
TTY message to press any key to continue.
LANGUAGE TTY_NMORE <string> (no default)
──────────────────────────────────────────────────────────────────────
TTY message when no more yellings are allowed
LANGUAGE YELL_TUNE1 <string> (no default)
──────────────────────────────────────────────────────────────────────
How to ask the user to play a tune.
LANGUAGE YELL_TUNE2 <string> (no default)
LANGUAGE YELL_TUNE3 <string> (no default)
LANGUAGE YELL_TUNE4 <string> (no default)
──────────────────────────────────────────────────────────────────────
Tell the user if he can play ANSI MUSIC or not!
LOG ANSIAUTO <on/off> (default off)
──────────────────────────────────────────────────────────────────────
To get an ansi logfile you've to set this to on.
LOG ANSIFILE <name> (no default)
──────────────────────────────────────────────────────────────────────
Sets the path and name to the ansi logfile. This logfile includes
all ansi sequences. If you use "type <name>" on an os/2 command
prompt the chat will be displayed to you from the users view.
LOG AUTO <on/off> (default on)
──────────────────────────────────────────────────────────────────────
Turns the logfile on at startup. If you use "off" you've to
use F2 in sixxac/CHAT to start logging.
LOG FILE <name> (no default)
──────────────────────────────────────────────────────────────────────
Path and name to the logfile. In this logfile all chatting
is captured in the format " FL> text..." wher 'F' stands for the
firstname and 'L' for the Lastname.
For example let "Unknown User" talk to "Unknown SYSOP":
****** BEGIN CHAT on 31-12-92 at 23:59:59 with Unknown User ******
UU> one second to the new year!
US> now - a HAPPY NEW YEAR!
****** END CHAT on 01-01-93 at 00:00:01 ******
MACRO <who> '<key>' "<words>" (no default)
MACRO <who> <ascii value> "<words>" (no default)
──────────────────────────────────────────────────────────────────────
<who> activates the macro for B (both), U (the user) or S (for the
sysop).
<key> or <ascii value> specifies the key you want to replace.
<words> may contain anything you like, except the " character.
All | will be replaced by carriage returns.
Examples:
MACRO B 'ä' "ae"
MACRO B 9 "%|* HELP: <CTRL>+<d> clear your window%|"
(you can find many more in the cfg file)
MAX_STOPTIME <on/off> (default on)
──────────────────────────────────────────────────────────────────────
Stop the users time when chatting? FOR REGISTERED USERS ONLY!
MULTINODE_PIPE <name> (default \\pipe\sixx)
──────────────────────────────────────────────────────────────────────
Pipename used in multiline mode.
Format: \\<server>\pipe\<name> or \pipe\<name>
<name> has to be 4 characters long!
Examples: \\server\pipe\sixx
\pipe\chat
Note: only available in sixxac/CHAT 1.0xML!
QUOTE FILE <name> (no default)
──────────────────────────────────────────────────────────────────────
Name of the quotes.mec file from Maximus.
(Format is quote - blank line - quote - blank line - ...)
Used with the translation character %q.
QUOTE NUM <number> (default -1)
──────────────────────────────────────────────────────────────────────
Sets the number of quotes in your quotes.mec file.
Use -1 to let sixxac/CHAT count the quotes or (on slower
machines) use numquote.exe and set the correct number!
REMOTE_EXIT <on/off> (default off)
──────────────────────────────────────────────────────────────────────
Let the user exit by typing an alias that has the %q in it.
It also sets if sixxac/CHAT should exit if the users time limit
is up! (in Multiline mode it's always on!)
SCROLL ABOVE <baudrate> (default 9600)
──────────────────────────────────────────────────────────────────────
<baudrate> is the baudrate you wish to use for scrolling chats.
Under that speed overwriting is used at startup!
SCROLL LINES <baudrate> <lines> (default 0 1)
──────────────────────────────────────────────────────────────────────
Defines how many lines you want to scroll when in scrolling
mode.
<baudrate> specifies above what rate to use <lines> for scrolling.
For example:
SCROLL LINES 0 9 ; 0 to 2399 baud use 9 lines
SCROLL LINES 2400 5 ; 2400 to 14399 baud use 5 lines
SCROLL LINES 14400 2 ; above 14400 baud use 2 lines
SYSOP <name> (default SYSOP)
──────────────────────────────────────────────────────────────────────
Your name (if you are the Sysop). It will be displayed on top
of your chat window. Also the first letter of the firstname and
the lastname is used for the logfile.
USER <1ST> <LAST> [<LEVEL> [<Y/DAY> [<Y/EVT> [<TUNE> [<COUNT>]]]]]
──────────────────────────────────────────────────────────────────────
Used to set Userlevels, yells per day, yells per event,
the tune and the countdown.
<1ST> <LAST> aree the users first and last name or "all users"
to set a level for all users. "all users" has to be the LAST
user definition!
<LEVEL> specifies the users yell-level. You may set it to "TWIT"
if you want to displey "no yell event" everytime the user tries
to yell. "SILENT" appears to the user if he is yelling, but you
won't hear a tune! "NORMAL" for normal user and "ALLEVENTS" for
users that may yell anytime (regardless of events). (default
NORMAL)
<Y/DAY> The maximum yells per day. (default 10)
<Y/EVT> The maximum yells per yell-event. (default 3)
<TUNE> May be the tune number to be played, 0 to let the user
select a tune or -1 to use the tune set for the active event.
(default -1)
<COUNT> the start value for the countdown or -1 to use the value
set for the active event. (default -1)
Example: USER David Lightman NORMAL 10 4 -1 10
The user "David Lightman" may yell 10 times a day, 4 times an
event. The tune will be taken from the active event and his
countdown will start at a value of 10.
Example: USER all users NORMAL 5 2
All users may yell 5 times a day, 2 times an event. The tune and
the countdown start value are taken from the active event.
VERSION <number> (no default)
──────────────────────────────────────────────────────────────────────
Version of your config file - set it to the sixxac/CHAT version.
WINDOW_STYLE <style> <shift> (default 0 0)
──────────────────────────────────────────────────────────────────────
window <style>:
0: sysop bottom, user top
1: sysop left, user right
2: sysop top, user bottom
3: sysop right, user left
<shift> is the number of lines/chars to make the sysop chat window
bigger than the user chat window. If you use a number smaller than
zero the users window will get bigger.
YELL ANSIABOVE <number> (default 9600)
──────────────────────────────────────────────────────────────────────
<number> is the baudrate you wish to use for ansi yelling.
Under that speed TTY messages are displayed when yelling.!
YELL ANSIYELL <name> (no default)
──────────────────────────────────────────────────────────────────────
Specifies the path and name of the ansi file. It is shown
when yelling.
YELL COUNTER <on/off/s_on> (default on)
──────────────────────────────────────────────────────────────────────
You can set to display the countdown simultaneously to the
ansi yell file (s_on), after the ansi yell file (on) or not (off).
YELL COUNTERX <x_screen_cordinate> (default 58)
YELL COUNTERY <y_screen_cordinate> (default 15)
──────────────────────────────────────────────────────────────────────
This sets the positon of the count down.
YELL DATAFILE <name> (default sc_user.dat)
──────────────────────────────────────────────────────────────────────
Path and filename where the user yellings are saved.
YELL EVENT <day> <start> <end> <tune#> <countdown> (no default)
──────────────────────────────────────────────────────────────────────
This is used to set a yell event. You may set as many as you
want!
<day> specifies the day when this event becomes active, it may
be one of the following: all, mon, tue, wed, thu, fri, sat, sun
<start> is the time when the event starts (hh:mm)
<end> is time when the event ends (hh:mm)
<tune> specifies the tune number in the tunes.bbs file to be
played. If you want the user to select the tune use 0!
<countdown> is the # of seconds for the countdown.
Example: Y_EVENT all 11:00 23:00 0 21
This will allow the user to select a tune to play between
11:00 and 23:00 all days of the week. The tune will be
played for 21 seconds.
YELL FLAG <name> (no default)
──────────────────────────────────────────────────────────────────────
Name of the no-yell flag file. If the file is found no yelling is
allowed!
YELL KEY <number> (default 0)
──────────────────────────────────────────────────────────────────────
Here you can specify what key you want to set if the user yells
and you do not answer.
You can then use this key within maximus to ask the user if he
wants to leave a comment or something else (look into the
configuration section for an example).
If you specify 0 no key will be set!
Key - Value Table:
XWVUTSRQ 6 | PONMLKJI 4 | HGFEDCBA 2 | 87654321 0
----------------|----------------|----------------|-----------------
x 0x80 | x 0x80 | x 0x80 | x 0x80
x 0x40 | x 0x40 | x 0x40 | x 0x40
x 0x20 | x 0x20 | x 0x20 | x 0x20
x 0x10 | x 0x10 | x 0x10 | x 0x10
x 0x08 | x 0x08 | x 0x08 | x 0x08
x 0x04 | x 0x04 | x 0x04 | x 0x04
x 0x02 | x 0x02 | x 0x02 | x 0x02
x 0x01 | x 0x01 | x 0x01 | x 0x01
Search for the key you wish to use. Get the number from the right
column and row. Add the number of zeros given on the top of the
table.
Example: Key J - Value in the 2nd column and 7th row (0x02). Now
add the number of zeros given at the top (4) and you get
the number 0x020000 for key J.
YELL NOANSWER <name> (no default)
──────────────────────────────────────────────────────────────────────
Specifies the path and name of the ansi file. It is shown
when the sysop did not answer the yell.
YELL NOMORE <name> (no default)
──────────────────────────────────────────────────────────────────────
Name of the file to show when the number of yells/day or
yells/event exceed the maximum.
YELL NOTYET <name> (no default)
──────────────────────────────────────────────────────────────────────
Specifies the path and name of the ansi file. It is shown
when yell is not allowed at this time.
YELL TUNES <name> (default tunes.bbs)
──────────────────────────────────────────────────────────────────────
This one sets the path and name of the MAXIMUS tunes.bbs file
────────────────────────────────────────────────────────────────────
TUNES.BBS file
────────────────────────────────────────────────────────────────────
I don't know from where or whom, but I got it a long time ago.
I hope nobody is annoyed if I include it within this package.
────────────────────────────────────────────────────────────────────
sc.err file
────────────────────────────────────────────────────────────────────
It is created when an error occours, following errors are
possible.
internal error <number>
──────────────────────────────────────────────────────────────────────
After an internal error sixxac/CHAT cleans up and tries to exit
immediately.
01,02 could not create thread
03 could not create semaphore
04 could not close semaphore
05,06 error while writing to the COMM port
08,09 error while writing to the PIPE
12,13 pipe has gone
file is corrupt!
──────────────────────────────────────────────────────────────────────
The SCP.EXE file has been damaged by something.
Check out for a virus!
tunesbbs: <name>
──────────────────────────────────────────────────────────────────────
The tunes.bbs file could not be opened.
userdata file: <name>
──────────────────────────────────────────────────────────────────────
The file to store the user's last yelling information could
not be opened or created!
config: <string>
──────────────────────────────────────────────────────────────────────
A unrecogniced config keyword was found.
carrier drop
──────────────────────────────────────────────────────────────────────
The caller dropped carrier and there was no LOGFILE to record
this.
open configfile: <name>
──────────────────────────────────────────────────────────────────────
The configfile could not be opened.
malloc: <number>
──────────────────────────────────────────────────────────────────────
out of memory - OS/2 has virtual memory and normaly this errors
should not occur, but just do be shure I included them.
01,02,03 no more space for aliases or macros
04 no more space for config filenames
05,06 no more space for yell events
07,08 no more space for user definitions
09,10,11 no more space for scroll back (should never occur)
────────────────────────────────────────────────────────────────────
sixxac/CHAT future features
────────────────────────────────────────────────────────────────────
o PM EXTENSION
o PM Log File Reader
o message to sysop (over Network)
o Multiline Support (is in beta yet)
────────────────────────────────────────────────────────────────────
Please send any bug reports to my bbs or route via FidoNet. There
you'll also get the newest version of sixxac/CHAT by requesting
"SIXXCHAT"!
────────────────────────────────────────────────────────────────────
sixxac/CHAT - end of dox
────────────────────────────────────────────────────────────────────